---
title: 'Ashby'
sidebarTitle: 'Ashby'
description: 'Access the Ashby API in 2 minutes 💨'
---
import { StatusWidget } from "/snippets/api-down-watch/status-widget.jsx"

<StatusWidget service="ashby" />

<Tabs>
  <Tab title="🚀 Quickstart">
    <Steps>
      <Step title="Create an integration">
        In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> _Configure New Integration_ -> _Ashby_.
      </Step>
      <Step title="Authorize Ashby">
        Go to [Connections](https://app.nango.dev/dev/connections) -> _Add Test Connection_ -> _Authorize_, then enter your Ashby API key. Later, you'll let your users do the same directly from your app.
      </Step>
      <Step title="Call the Ashby API">
        Let's make your first request to the Ashby API (fetch a list of all candidates in an organization). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):
        <Tabs>
            <Tab title="cURL">

                ```bash
                curl -X POST "https://api.nango.dev/proxy/candidate.list" \
                  -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
                  -H "Provider-Config-Key: <INTEGRATION-ID>" \
                  -H "Connection-Id: <CONNECTION-ID>" \
                  -H "Accept: application/json" \
                  -H "Content-Type: application/json" \
                  -d '{"limit": 10}'
                ```
            </Tab>

            <Tab title="Node">

            Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

            ```typescript
            import { Nango } from '@nangohq/node';

            const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

            // Lists all candidates in an organization.
            const res = await nango.post({
              endpoint: '/candidate.list',
              providerConfigKey: '<INTEGRATION-ID>',
              connectionId: '<CONNECTION-ID>',
              data: {
                limit: 10
              }
            });

            console.log(res.data);
            ```
            </Tab>

        </Tabs>

        Or fetch credentials dynamically via the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

      </Step>
    </Steps>

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.

    <Tip>
    Next step: [Embed the auth flow](/getting-started/quickstart/embed-in-your-app) in your app to let your users connect their Ashby accounts.
    </Tip>
  </Tab>
  <Tab title="🔗 Useful links">
    | Topic | Links |
    | - | - |
    | Authorization | [Guide to connect to Ashby using Connect UI](/integrations/all/ashby/connect) |
    | General | [Ashby Website](https://ashbyhq.com/) |
    | | [Ashby Dashboard](https://app.ashbyhq.com/) |
    | Developer | [How to generate an API key](https://ashbyhq.notion.site/How-do-I-generate-an-API-key-58d3409382014a3d80c3b08e982644d7#b3aba2a4d3694e12a2addee1c63d7d4d) |
    | | [Ashby API docs](https://developers.ashbyhq.com/reference/introduction) |
    | | [API Authentication](https://developers.ashbyhq.com/reference/authentication) |
    | | [API Key Endpoint Permissions](https://developers.ashbyhq.com/reference/authentication#api-key-endpoint-permissions) |

    <Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/ashby.mdx)</Note>
  </Tab>
  <Tab title="🚨 API gotchas">
      - Ashby gives you only an `API Key` but uses Basic auth for the API. Pass the `API Key` as the username to Nango and leave the password blank.
      - The `apiKey.info` scope is required for the api key to pass verification.

    <Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/ashby.mdx)</Note>
  </Tab>
</Tabs>

<Info>
    Questions? Join us in the [Slack community](https://nango.dev/slack).
</Info>
